3

Menus and Dialog Boxes

Menus group an application's primary functions and make them readily available, while dialog boxes offer easy access to a variety of controls. Menus and dialog boxes let you "feel" your way through an application and learn it by intuition.

The menus and dialog boxes in the avenue.quark interface make it easy for you to tag the content of QuarkXPress documents, save that content in XML format, and identify the tagged content in the QuarkXPress document from which it came.

When avenue.quark is installed, the QuarkXPress File menu lets you create a new XML document.

File > New

The XML command (Command+Shift+X on Mac OS, Ctrl+Shift+X on Windows) displays the New XML dialog box, which lets you select a DTD, root element, and tagging rule set to use in creating an XML document.

XML command

File > New > XML

The New XML dialog box lets you specify a template, DOCTYPE, and default tagging set for a new XML document.

New XML dialog box

File > New > XML

The Template list lets you select the XML template (if any) you would like the new XML document to be based on. The list menu displays the names of all XML templates in the "Templates" folder in the QuarkXPress folder. For more information about XML templates, see "Working with XML Templates" in Chapter 6, "Tagging Content."

Template list

To create a new XML document that is not based on a template, select Custom in the Template list.

File > New > XML

The DOCTYPE area lets you select a DTD and root element for a new XML document. If you select Custom in the Template list, you can click Import to import a DTD and then choose a root element from the Root Element pop-up menu. If you select a template in the Template list, the template's DTD and root element are displayed, but cannot be changed.

DOCTYPE area

• The Import button displays a dialog box that lets you import a new DTD.
• The Root Element pop-up menu lets you choose a root element from the list of element types in the selected DTD. The root element you choose determines the configuration of the XML tree displayed in the XML Workspace palette.

File > New > XML

The Tagging Rule Set area lets you choose a default tagging rule set for the new XML document.

Tagging Rule Set area

• The Default Set pop-up menu displays a list of tagging rule sets associated with the root element/DTD pair selected in the DOCTYPE area, or None if not tagging rule sets are associated with that pair.

The tagging rule set chosen in the Default Set pop-up menu is the default selection displayed in the Tagging Rule Set pop-up menu in the XML Workspace palette. The tagging rule set can be changed at any time in the XML Workspace palette.

The Edit menu lets you specify avenue.quark preferences and create tagging rule sets and categories.

Edit > Preferences > avenue.quark

The avenue.quark Preferences command displays the avenue.quark Preferences dialog box.

avenue.quark Preferences command

Edit > Preferences > avenue.quark

The avenue.quark Preferences dialog box lets you specify how tagged content appears on-screen, control the color of marker text, and turn dynamic content updating on and off.

avenue.quark Preferences dialog box

Edit > Preferences > avenue.quark

The Show Tagged Content area lets you specify the colors used to display tagged and untagged content when Show Tagged Content is selected in the Utilities menu. To change the display color for tagged content, click the Tagged Text button. To change the display color for untagged content, click the Untagged Text button.

The Show Tagged Content command works only in QuarkXPress 4.1 or later.

Show Tagged Content area

Edit > Preferences > avenue.quark

This area lets you control how decisions are made during rule-based tagging.

• The Always insert repeating elements at the end of the current branch check box controls the placement of new repeating elements (elements marked with a + or in the DTD). When this box is checked, avenue.quark always puts new repeating elements at the end of the active branch. When this check box is unchecked, avenue.quark displays the Choose Rule/Position dialog box and lets you manually choose the position of a new repeating element.
• The Always use first available path for elements with multiple insertion paths check box controls the placement of new elements that could be inserted in a number of places according to the DTD. For example, say a tagging rule calls for the creation of a <paragraph> element. If the DTD states that a new <paragraph> element may be created either at the end of the current branch or as a child of a new <sidebar> element, which kind of <paragraph> element should avenue.quark generate? If this check box is checked, avenue.quark creates the first <paragraph> element it finds in the DTD tree (a <paragraph> element at the root level of the current branch). If this check box is unchecked, avenue.quark displays the Choose Rule/Position dialog box.
• The Always use the first applicable tagging rule check box applies to tagging rule conflicts. When this box is checked, avenue.quark always chooses the first of a series of applicable rules in tagging rule conflicts. When this box is unchecked, avenue.quark displays the Choose Rule/Position dialog box and lets you manually choose the element type to be applied to the selected text or click Choose Automatically.

Edit > Preferences > avenue.quark

The Marker Text button lets you specify the color of the brackets that surround tagged text when you choose View > Show Invisibles. To change the color of the brackets, click the button.

Marker Text button

Edit > Preferences > avenue.quark

The Enable Dynamic Content Update button lets you specify whether the content of elements in active XML documents should be continuously updated to reflect the content of the QuarkXPress items they're linked to. You might want to uncheck this button if QuarkXPress seems to be running very slowly when editing large XML documents; you can manually update the content when this box is unchecked by clicking the Synchronize Content button in the XML Workspace palette.

Enable Dynamic Content Update check box

Synchronize Content button (XML Workspace palette)

Edit > Tagging Rules

The Tagging Rules command displays the Tagging Rules dialog box, which lets you create, edit, duplicate, and delete tagging rule sets for the active XML document.

Tagging Rules command

Edit > Tagging Rules

The Tagging Rules dialog box lets you create, edit, duplicate, and delete tagging rule sets for the DOCTYPE of the active XML document. The tagging rule sets you create in this dialog box are available in the Tagging Rule Set pop-up menu in the document's XML Workspace palette.

Tagging Rules dialog box

• The DOCTYPE field displays the DOCTYPE used by the active document, including the DTD and the <root element>.
• The Tagging Rule Set list displays a list of tagging rule sets for the XML document and lets you choose a tagging rule set to edit.
• The New Set button displays the Edit Tagging Rules dialog box, which lets you create a new tagging rule set for the XML document.
• The Edit button displays the Edit Tagging Rules dialog box, which lets you edit the tagging rule set highlighted in the Tagging Rule Set list.
• The Duplicate button creates a copy of the tagging rule set highlighted in the Tagging Rule Set list. For more information about the Edit Tagging Rules dialog box, see "Edit Tagging Rules (dialog box)" in this section.
• The Delete button removes the tagging rule set highlighted in the Tagging Rule Set list.
• The Save button saves changes made to any tagging rule set in the Tagging Rules dialog box. When you click Save, avenue.quark closes the dialog box.
• The Cancel button closes the Tagging Rules dialog box and discards any changes made since opening it.

Tagging rule sets are saved as part of avenue.quark XML documents; they are not stored in a preferences file.

Edit > Tagging Rules > New, Edit, or Duplicate

Clicking New, Edit, or Duplicate in the Tagging Rules dialog box displays the Edit Tagging Rules dialog box, which lets you create and edit tagging rule sets.

Edit Tagging Rules dialog box

• The Name field lets you name a new tagging rule set or rename an existing tagging rule set.
• Below the Name field are the DTD Tree list, the Rules list, and the Rule Setting area. The DTD Tree list (on the left side of the dialog box) displays a tree view of the DTD and its element types including optional element types and lets you select an element type for which to define tagging rules. The right side of the dialog box lets you specify tagging rules for the selected element type.

You can use the Tab key to move from the selected element in the DTD list through the steps in the dialog box required to define a tagging rule.

Edit > Tagging Rules > New, Edit, or Duplicate

The DTD Tree list displays the selected DTD. You can scroll through the list with the horizontal and vertical bars or with the arrow keys. You can display or hide the contents of container elements by clicking the and icons (Mac OS) and the and icons (Windows).

DTD Tree list

A symbol at the beginning of each element's name indicates how many of that element may be contained by the parent element type:

• indicates one and only one
• indicates zero or one
• indicates one or more
• indicates zero or more

A symbol at the end of an element's name indicates the relationship this element can have with other elements:

• indicates that this element must be followed by the next element
• indicates that either this element or the next element may be used here

If an element's name is bold and black, you can create tagging rules for that element type. If an element's name is bold, black, and italic, the tagging rule set already contains at least one rule for that element type. If an element's name is unavailable, no tagging rules may be created for that element type.

Edit > Tagging Rules > New, Edit, or Duplicate

The Add Rule, Duplicate, and Delete buttons let you add, duplicate, and delete tagging rules in the Rules list.

Add Rule, Duplicate, and Delete buttons

• The Add Rule button lets you add a tagging rule to the Rules list
• The Duplicate button lets you duplicate the tagging rule selected in the Rules list
• The Delete button lets you delete the tagging rule selected in the Rules list

Edit > Tagging Rules > New, Edit, or Duplicate

The Rules list displays the tagging rules for the selected element type. The rule names in this list reflect the selections made in the Rule Setting area for each rule.

To edit a tagging rule, select its name in the list and change its definition in the Rule Setting area.

Rules list

Edit > Tagging Rules > New, Edit, or Duplicate

The Rule Setting area lets you configure the tagging rule selected in the Rules list. The options available in this area are based on the active QuarkXPress document.

Rule Setting area

• The Style Sheet check box and pop-up menu let you specify that text that uses a particular paragraph or character style sheet should be tagged with the selected element type. Checking the New tag for each paragraph box specifies that avenue.quark should tag each paragraph styled with the indicated style sheet as a separate element (if the DTD permits it). Unchecking the New tag for each paragraph box specifies that avenue.quark should tag a range of paragraphs styled with the indicated style sheet as a single element.
• The Color check box and pop-up menu let you specify that only text that uses a particular color should be tagged with the selected element type.
• The Type Style check box and button list let you specify that only text that uses a particular type style should be tagged with the selected element type.

The View menu lets you display brackets around tagged content in the active QuarkXPress document.

View menu

In addition to its regular QuarkXPress functionality, the Show Invisibles command displays markers before and after tagged content in the active QuarkXPress document. You can control the color of these markers in the avenue.quark Preferences dialog box (Edit > Preferences > avenue.quark). The Hide Invisibles command hides these markers.

Show Invisibles command

Text with brackets, as displayed by the Show Invisibles command.

The Utilities menu lets you show tagged content in the active QuarkXPress document.

Utilities menu

The Show Tagged Content command displays tagged and untagged content in the active QuarkXPress document with a particular color. You can specify this color in the avenue.quark Preferences dialog box (Edit > Preferences > avenue.quark).

Show Tagged Content command

The Show Tagged Content command works only in QuarkXPress 4.1 or later.

The Choose Rule/Position dialog box is displayed in two different situations:

• When two different tagging rules could be applied to a given range of text
• When a new element could be inserted at a number of different places in the active branch of the XML tree

The Choose Rule/Position dialog box lets you determine which rule to use when text matches more than one tagging rule. It also lets you choose a position for a tagged element when more than one position is available.

The controls in this dialog box work as follows:

• The Element Type field lists the element types that can be applied to the selected text. The options in this list are sorted as described in "Rule weighting."
• The Element Type Description field displays the path of the element that will be created if the element type selected in the Element Type field is used. A number in a bracket indicates the position of a child relative to its parent; for example, /whitePaper/body[2] represents a new <body> element that will be the second child element of <whitePaper>. A dot at the end of a path indicates that if that path is selected, the text will be appended to the end of the indicated element.
• The Choose Automatically button tags the selected text using the avenue.quark automatic tagging algorithm. This algorithm works as if the first two check boxes in the Tagging Rule/Position Options area (Edit > Preferences > avenue.quark) were checked (see "avenue.quark Preferences") and automatically selects the top match in the Element Type field. After you click this button, rule-based tagging then continues with these settings until the end of the selected text is reached.
• The Stop button stops the tagging process without tagging the selected text.
• The OK button tags the selected text with the element type listed in the Element Type field, at the position indicated by the Element Type Description field. Tagging then resumes.

For more information, see "avenue.quark Preferences" in this section.